home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / wildcat / wconvert.zip / WCONVERT.DOC < prev   
Text File  |  1992-01-18  |  9KB  |  201 lines
  1.  
  2.  
  3.  
  4.                                   WCONVERT
  5.  
  6.                Wildcat! 3.x Display File Conversion Utilities
  7.                           Distributed as Shareware
  8.  
  9.                             Copyright (c) 1991-92
  10.                                 Thomas Gettys
  11.  
  12.  
  13.       -----------------------------------------------------------------
  14.                                                                Overview
  15.       -----------------------------------------------------------------
  16.  
  17.       Welcome!   You  have in your hands an  invaluable  (and  unique!)
  18.       tool  that   dramatically  eases  the  task  of   generating  and
  19.       modifying display files for version 3.x of Wildcat.  This tool is
  20.       comprised  of  two complimentary programs, SCR2BBS  and  BBS2SCR.
  21.  
  22.       BBS2SCR  will convert any Wildcat 3.x display file into a  format
  23.       that  can be used with any ANSI editor, giving you the  power  to
  24.       SEE what you are doing while you design or modify a screen!
  25.  
  26.       Once  you have placed each item exactly where you want it and  in
  27.       the  colors you want, use SCR2BBS to convert your  creation  back
  28.       into the format that Wildcat 3.x understands.
  29.  
  30.                                    -=(*)=-
  31.  
  32.       Although  you  may  not have paid anything to get  this  copy  of
  33.       WCONVERT, it is not free.  WCONVERT is distributed as shareware.
  34.  
  35.       Shareware is a form of distribution which gives users a chance to
  36.       try software before buying it. If you try a Shareware program and
  37.       continue to use it, you are expected to register it.
  38.  
  39.       You are granted a limited license to use WCONVERT for  evaluation
  40.       purposes.  If you decide to continue using it, you must  register
  41.       your copy.
  42.  
  43.       -----------------------------------------------------------------
  44.                                                                 SCR2BBS
  45.       -----------------------------------------------------------------
  46.  
  47.       SCR2BBS  will  convert  Wildcat 2.x color  display  files  (those
  48.       with  the  .SCR extension) to the new Wildcat  3.x  display  file
  49.       format.
  50.  
  51.       That  is,  the version 2.x control character sequences  are   re-
  52.       placed  by their equivalent version 3.x @-codes, as well  as  the
  53.       conversion  of ANSI escape sequences for colors (and some  cursor
  54.       positioning).
  55.  
  56.       More  importantly, SCR2BBS will also aid the design of new   dis-
  57.       play  files, by  allowing you  to continue  to use  an ANSI  draw
  58.       program  (e.g., THEDRAW), and then convert your new creation  for
  59.       use in the Wildcat environment.
  60.  
  61.  
  62.       -----------------------------------------------------------------
  63.                                                                 BBS2SCR
  64.       -----------------------------------------------------------------
  65.  
  66.       The  second  component  is  the complement  of  SCR2BBS,   named,
  67.       (quite  cleverly), BBS2SCR.  This program actually  performs  two
  68.       functions.
  69.  
  70.       First,  it allows you to view a Wildcat version 3.x display  file
  71.       as  your  users  would see it (i.e. in color).   Very  handy  for
  72.       verifying that it looks the way you intended it to!
  73.  
  74.       Also,  by  re-directing the output into a file, you  can  capture
  75.       the results  for  additional  editing  using  your  favorite ANSI
  76.       draw program.
  77.  
  78.       This  function  is vital in order to close-the-loop;  using  only
  79.       text  mode characters for color screens is nice in one  way,  but
  80.       without a means for designing such screens, viewing the  results,
  81.       and  then modifying them easily later, it becomes a one-way  trap
  82.       (as you  no doubt have found out!).
  83.  
  84.       -----------------------------------------------------------------
  85.                                                              Invocation
  86.       -----------------------------------------------------------------
  87.  
  88.                       Syntax: SCR2BBS SrcFile [DstFile]
  89.  
  90.       SrcFile  is the name  of the file to  be converted,  and  DstFile
  91.       is the name of  the converted file.   If DstFile is  not  provid-
  92.       ed,  it will have the same name as the source file, but take  the
  93.       extension BBS.
  94.  
  95.       The  default file extension for the source file is SCR,  and  for
  96.       the destination file it is BBS.
  97.  
  98.       For  example, the following commands are all  equivalent,  taking
  99.       the  file MAIN5.SCR as input, and generating as output  the  file
  100.       MAIN.BBS:
  101.  
  102.       SCR2BBS MAIN5
  103.       SCR2BBS MAIN5.SCR
  104.       SCR2BBS MAIN5 MAIN5
  105.       SCR2BBS MAIN5 MAIN5.BBS
  106.       SCR2BBS MAIN5.SCR MAIN5.BBS
  107.  
  108.  
  109.  
  110.                      Syntax: BBS2SCR SrcFile [>DstFile]
  111.  
  112.       SrcFile  is  the name of the file to be converted.   The  default
  113.       file extension for the source file is BBS.  The output is sent to
  114.       the standard output device.
  115.  
  116.       Thus,  if you wish to see a Wildcat display file named  FILE9.BBS
  117.       as the use would see it, just enter the command BBS2SCR FILE9.
  118.  
  119.       If desired, the output can  be redirected into a file,  using the
  120.       standard  DOS redirection construct: ">filename.ext".   The  file
  121.       can  then  be edited,  using a  program that  supports ANSI  con-
  122.       trol codes (again, such as THEDRAW).
  123.  
  124.       -----------------------------------------------------------------
  125.                                                      SCR2BBS Processing
  126.       -----------------------------------------------------------------
  127.  
  128.       SCR2BBS  will  convert the embedded control  character  sequences
  129.       used by Wildcat 2.xx into the @-delimited strings used by Wildcat
  130.       3.xx.
  131.  
  132.       Additionally  (and  more importantly!), it  will  translate  ANSI
  133.       color  ESC sequences into  @-delimited strings used   by  Wildcat
  134.       3.xx;   it  will  also  correctly  handle  some   of  the  cursor
  135.       positioning  ESC  sequences  often found in  files  generated  by
  136.       THEDRAW.
  137.  
  138.       If a control or ESC sequence is encountered that is not  support-
  139.       ed  and/or  not  interpretable in the  context  in  which  it  is
  140.       found, an error message is output  to the screen.  The  offending
  141.       codes will simply be skipped over and processing  will continue.
  142.  
  143.       SCR2BBS  should  convert most files properly, but in  some  cases
  144.       the  generated file  may require  a small  amount of   massaging;
  145.       almost always it is a simple matter of joining lines, using  your
  146.       favorite text editor.
  147.  
  148.       Note,  however,  that ANSI  files that  uses animation   can  NOT
  149.       be converted, for the  simple reason that  there are no   Wildcat
  150.       3.xx codes for cursor positioning.
  151.  
  152.  
  153.       -----------------------------------------------------------------
  154.                                                      BBS2SCR Processing
  155.       -----------------------------------------------------------------
  156.  
  157.       I  decided  to convert only the Wildcat v3.x "@xx@"  color  codes
  158.       into their equivalent ANSI escape sequences, in order to have the
  159.       least impact on your  files (i.e., I  didn't want to  remove  any
  160.       System  nor User Codes that you had embedded, so that they  would
  161.       remain, following any subsequent editing).
  162.  
  163.       -----------------------------------------------------------------
  164.                                                    If you have PROBLEMS
  165.       -----------------------------------------------------------------
  166.  
  167.       If  you  use  THEDRAW, load the original file and  then  save  it
  168.       using  the  "None"  option  for  "line  length".   This has  cor-
  169.       rected  all  problems  known to-date (NOTE: if  the  source  file
  170.       contains  Wildcat 2.xx control  codes, you  will have  to  repair
  171.       them (as  before!) after handling by THEDRAW).
  172.  
  173.       If   you  have  a  file  that  resists conversion, upload  it  to
  174.       the  MicroManiac!   BBS  @  (303) 673-9470  and  I  will  assist.
  175.       Questions,  suggestions, requests can be left for me at same,  or
  176.       on Compu$erve (72730,2013).
  177.  
  178.  
  179.       -----------------------------------------------------------------
  180.                                                            Registration
  181.       -----------------------------------------------------------------
  182.  
  183.       If  you find WCONVERT useful and you continue to use it, you  are
  184.       required to make a registration payment of $15.  Upon receipt  of
  185.       your  registration you will be sent a disk with the  most  recent
  186.       version which has, of course, no requests for registration in it!
  187.  
  188.       Your feedback is most welcome; if you have any suggestions on how
  189.       WCONVERT  could be improved to better meet your needs, please  be
  190.       sure to include a note when you register.
  191.  
  192.       As   always,  support  of  a  shareware  program (by the  author)
  193.       is determined by the support of the program (by its users); i.e.,
  194.       it's a two-way street!
  195.  
  196.  
  197.                      Send to: Thomas Gettys
  198.                               700 Snowberry Ct.
  199.                               Lafayette, CO 80026
  200.  
  201.